home *** CD-ROM | disk | FTP | other *** search
/ Merciful 5 / Merciful - Disc 5.iso / software / p / progedv2.4+pseudokeyfile.lha / InstallProgED / HTMLClient_GER < prev    next >
Encoding:
Text File  |  1997-04-20  |  9.4 KB  |  297 lines
  1.  
  2.                             HTMLClient V1.1
  3.                           -------------------
  4.  
  5.  
  6. Introduction
  7. -------------
  8.  
  9.     Starting from ProgED v2.3 release, you'll find, into the
  10. ProgED distribution package, a client using a MUI interface. Its
  11. aim is to help user to write his (her) HTML pages. This client
  12. supply the same GUI of WebPlug because, now, it's the best
  13. available on Amiga. I wrote this client because, by now, ProgED
  14. is no more a programmers dedicated editor, as it was on previous
  15. releases, but it is became a general purpose editor. Actually,
  16. furthermore, many peoples need special editors, to help them
  17. compiling their HTML pages (a simple but boring job). From all
  18. this considerations the idea to write a user helping client was
  19. born. I wrote this program using a MUI interface because this
  20. has lowered developing time, but also because it was necessary a
  21. functional interface different from the Triton or gadtools ones.
  22. Last, the HTML creators are GUI exigents. The client was write
  23. in a customizable way: it allows use of 3 pre-configure browsers
  24. (IBrowse, AWeb & Voyager/Mindwalker) or use of a custom browser
  25. specifing all needed informations about it. The client,
  26. furthermore, automatically modify link and image names to adapt
  27. them to the host where they will be copied. It's possible, using
  28. a single mouse click, to "send" the actually edited page to the
  29. browser (in case loading it, if it's not yet in memory) to see,
  30. then, done changes in real time. Using a special ProgeD filetype
  31. allows to automatically color all HTML 3.0 tags allowing you to
  32. easily find them. A new client mode, introduced on purpose for
  33. this client, allows to translate "on the fly" typed characters
  34. (with an ascii code between 160 and 255) to the relative HTML
  35. tag.
  36.  
  37.  
  38. Installating & configurating
  39. -----------------------------
  40.  
  41.      Installating and configurating the client is very easy. To be
  42. simple I'll refer to the standard prefs supplied together ProgED 2.4.
  43. Using those prefs the installation is not necessary, who is not using
  44. them must insert the client in the ProgED clients list and use the
  45. new internal commands (which are introduced by the client) in a
  46. toolbar, key or a menu. You can configure the client using the
  47. internal command HTML_PREFS or pressing the special button of the
  48. HTML filetype toolbar. When the prefs window is opened you have only
  49. to follow the MUI on line help to configure the client.
  50.  
  51.  
  52. Usage
  53. ------
  54.  
  55.      First of all standard ProgED prefs define a toolbar for all
  56. html editing windows. Using this toolbar you can insert easily
  57. a lot of tags. Even the client does not only this...
  58.  
  59.      Open prefs window (using the little "question" button on the
  60. toolbar or even using the HTML_PREFS internal command. Click on
  61. "Miscellaneous" page, then activate the compilation flag. Now,
  62. as soon as you send a HTML page to your browser or click on the
  63. "eye" toolbar button or start the HTML_BROWSE internal command
  64. the client will COMPILE your page. What it means ? The client
  65. will check (almost) every link in your page(s) and, in case,
  66. will open an error window showing link errors. More, you can
  67. define a file "HTML.config" in main drawer of your site (the
  68. one wrote in "File base" gadget of prefs window). Here it is a
  69. small example:
  70.  
  71. CUT HERE>-----------------------------------------
  72.  
  73. ; Check links to pages (<A HREF="xxx">)
  74. CHECKPAGELINKS
  75.  
  76. ; Check links to images (<IMG SRC="xxx">)
  77. CHECKIMAGELINKS
  78.  
  79. ; Check links to musics (<EMBED SRC="xxx">)
  80. CHECKMUSICLINKS
  81.  
  82. ; Check links to backgrounds (<BODY BACKGROUND="xxx">)
  83. CHECKBACKGROUNDLINKS
  84.  
  85. ; Check for unused files
  86. CHECKNOTREFERENCED
  87.  
  88. ; Which file I must check ?
  89. PATTERN #?.(html|htm)
  90.  
  91. ; Index file name
  92. INDEX index.html
  93.  
  94. ; New tag definition
  95. ; HEADER = New tag name
  96. ; ARG1 = tag arguments
  97. NEWTAG <HEADER> $(ARG1)
  98. <$(ARG1)>
  99. <IMG SRC="pics/proged.gif" WIDTH="314" HEIGHT="97" ALT="ProgED"><br>
  100. <IMG SRC="pics/homepage.gif" WIDTH="349" HEIGHT="77" ALT="home page"><br>
  101. /NEWTAG
  102.  
  103. ; Var definition
  104. VAR address=3donline@ita.flashnet.it
  105.  
  106. CUT HERE>-----------------------------------------------------------
  107.  
  108. Using this example you can insert:
  109.  
  110. <!--VAR $(address)--><!--/VAR-->
  111.  
  112. in your page to insert your address at compile time. More, if you write:
  113.  
  114. <!--HEADER $(center)--><!--/HEADER-->
  115.  
  116. you can insert the above (see example) macro and substitute $(ARG1)
  117. for CENTER to get a "<CENTER>".
  118.  
  119.      I bet you're asking yourself: "How it works?". The answer is
  120. simple. After a compilation you'll see in your page:
  121.  
  122. <!--VAR $(address)-->3donline@ita.flashnet.it<!--/VAR-->
  123.  
  124. <!--HEADER $(center)-->
  125. <center>
  126. <IMG SRC="pics/proged.gif" WIDTH="314" HEIGHT="97" ALT="ProgED"><br>
  127. <IMG SRC="pics/homepage.gif" WIDTH="349" HEIGHT="77" ALT="home page"><br>
  128. NEWTAG <HEADER>
  129. <!--/HEADER-->
  130.  
  131. ProgED, in fact, while compiling, will delete all text between start
  132. and end tags (<!--VAR--> & <!--/VAR--> for example) and will write
  133. the new one.
  134.  
  135. Well, now you should asking yourself: "I need it?". I think yes.
  136. This useful macros will help you to manage your site easily. Usually,
  137. for example, I make page headers and footers all equal. Creating
  138. them as macro you can change all your site changing only the
  139. HTML.config file and recompiling your site.
  140.  
  141.  
  142. The HTML.Config file
  143. ---------------------
  144.  
  145.       Follow these rules to write it:
  146.  
  147. 1) Empty lines are ok.
  148. 2) Every comment must start with a ';'
  149. 3) These are right keywords (case insensitive):
  150.  
  151.         a) CHECKPAGELINKS
  152.  
  153.            Enable check for page links (default).
  154.            Use NOCHECKPAGELINKS to disable it.
  155.  
  156.         b) CHECKIMAGELINKS
  157.  
  158.            Enable check for image links (default).
  159.            Use NOCHECKIMAGELINKS to disable it.
  160.  
  161.         c) CHECKMUSICLINKS
  162.  
  163.            Enable check for music links (default).
  164.            Use NOCHECKMUSICLINKS to disable it.
  165.  
  166.         d) CHECKBACKGROUNDLINKS
  167.  
  168.            Enable check for background links (default).
  169.            Use NOCHECKBACKGROUNDLINKS to disable it.
  170.  
  171.         e) CHECKNOTREFERENCED
  172.  
  173.            Enable check for unused links.
  174.            Use NOCHECKNOTREFERENCED to disable it (default).
  175.  
  176.         f) PATTERN <amigados pattern>
  177.  
  178.            Specify files to be checked (default: "#?.(html|htm)").
  179.  
  180.         g) INDEX <index file name>
  181.  
  182.            Specify file names of index pages (default: "index.html").
  183.  
  184. 4) New tag creation:
  185.  
  186.         NEWTAG <NAME> $(ARG1) $(ARG2) ... $(ARGn)
  187.         ...
  188.         Text using arguments $(ARG1) $(ARG2) ... $(ARGn)
  189.         ...
  190.         /NEWTAG
  191.  
  192.    Usage in HTML pages:
  193.  
  194.    <!--NAME $(this is arg1) $(this is arg2) ... $(this is argn)-->
  195.    <!--/NAME-->
  196.  
  197. 5) Variables creation:
  198.  
  199.         VAR NAME=text of variable
  200.  
  201.    Usage in HTML pages:
  202.  
  203.    <!--VAR $(NAME)-->
  204.    <!--/VAR-->
  205.  
  206. 6) You cannot nest variables and macro (in this version).
  207.  
  208.  
  209.       Note that not using a HTML.config file default settings will
  210. allows you to check for wrong page links, even.
  211.  
  212.  
  213.  
  214. Distribution
  215. -------------
  216.  
  217.      HTMLClient is, till now, distributed as GIFTWARE. It means that
  218. anyone (who has a registered ProgED copy) can use it. The client user
  219. can send me any "gift" to pay me. Even HTMLClient is and will be
  220. Copyright by Giovanni Lambiase and, in future, I reserve any right on
  221. it. In future, HTMLClient could be Public Domain (distributing it
  222. separately by ProgED and, in case, suppling sources too) or Shareware
  223. asking for a registration fee different from the ProgED one. Even
  224. who will send me a "gift" will automatically be a registered user and
  225. will get his (her) keyfile. Last, I can decide to stop client
  226. development (right which I reserve about ProgED itself, too). Even if
  227. HTMLClient is GIFTWARE it MUST NOT be distributed separately from
  228. ProgED. This program can be used ONLY together ProgED and is, then,
  229. necessary and obligatory to distribute them together. All ProgED
  230. users who do not use this client must not, of course, send me a "gift".
  231.  
  232.  
  233.  
  234. Author
  235. -------
  236.  
  237.     Even if I think it's not necessary, here they are my data:
  238.  
  239.        Giovanni Lambiase
  240.        Via Capo Di Piazza , 6
  241.        84010 Minori (SA) - Italy
  242.  
  243. You'll find more informations about me in ProgED docs.
  244.  
  245.  
  246.  
  247. Conclusion
  248. -----------
  249.  
  250.     I wrote this client in 10 days and, them, I think not all ones
  251. are happy about it; I only wanted to offer a bonus to all ProgED
  252. registered users. Even are well-coming bug-reports and suggests.
  253. It's preferable, of course, use e-mail to send me them. Regard
  254. future, HTMLClient development will continue parallely together
  255. ProgED till I find it useful.
  256.  
  257.  
  258.  
  259. ----------------------------------------------------------------------
  260.  
  261.                           This application uses
  262.  
  263.  
  264.                         MUI - MagicUserInterface
  265.  
  266.                 (c) Copyright 1993-96 by Stefan Stuntz
  267.  
  268.  
  269. MUI is a system to generate and maintain graphical user interfaces. With
  270. the  aid  of  a  preferences program, the user of an application has the
  271. ability to customize the outfit according to his personal taste.
  272.  
  273. MUI is distributed as shareware. To obtain a complete package containing
  274. lots of examples and more information about registration please look for
  275. a  file  called  "muiXXusr.lha"  (XX means the latest version number) on
  276. your local bulletin boards or on public domain disks.
  277.  
  278.           If you want to register directly, feel free to send
  279.  
  280.  
  281.                          DM 30.-  or  US$ 20.-
  282.  
  283.                                   to
  284.  
  285.                              Stefan Stuntz
  286.                         Eduard-Spranger-Straße 7
  287.                              80935 München
  288.                                 GERMANY
  289.  
  290.  
  291.  
  292.              Support and online registration is available at
  293.  
  294.                           http://www.sasg.com/
  295.  
  296.  
  297.